Audio-to-Text Map Module JSON Reference
Declared in | AudioToTextMap.schema.json |
Overview
An Audio-to-Text Map module maps an audio file name to corresponding text string which can be synthesized for audio playback to replace audio playback of the recorded audio file.
Note: Unless stated otherwise, value of properties that are of type "string"
can be updated at runtime by an application if their value is entered as a field name wrapped by "$["
and "]"
. If a property is of a type other than "string"
, then an additional property of type "string"
with the same property name appended with the string "Runtime"
is added to have its value entered as a field name wrapped by "$["
and "]"
. This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
audioFile
Audio File Name. The value cannot be set at runtime. Example:
"audioFile": "Hello.wav".
Parameter is required.
-
textString
A text string to be speech synthesized for audio playback to replace audio playback of invalid value for
"audioFile"
property. The value can be set at runtime using"$[<FieldName>]"
entry convention. Example:"textString": "Hello there"
. Runtime example:"textString": "$[TextToSpeak]"
.Parameter is required.
-
textLanguageCode
The language locale code of the text in
"textString"
property. The value can be set at runtime using"$[<FieldName>]"
entry convention. Default:"en-US"
. Runtime example:"textLanguageCode": $[LanguageCode]"
.Parameter is optional.
Properties
audioFile
"audioFile": string
Discussion
Audio File Name. The value cannot be set at runtime. Example: "audioFile": "Hello.wav".
Parameter is required.
Declared In
AudioToTextMap.schema.json
textLanguageCode
"textLanguageCode": string
Discussion
The language locale code of the text in "textString"
property. The value can be set at runtime using "$[<FieldName>]"
entry convention. Default: "en-US"
. Runtime example: "textLanguageCode": $[LanguageCode]"
.
Parameter is optional.
Declared In
AudioToTextMap.schema.json
textString
"textString": string
Discussion
A text string to be speech synthesized for audio playback to replace audio playback of invalid value for "audioFile"
property. The value can be set at runtime using "$[<FieldName>]"
entry convention. Example: "textString": "Hello there"
. Runtime example: "textString": "$[TextToSpeak]"
.
Parameter is required.
Declared In
AudioToTextMap.schema.json